home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / EDITORS / ZAP130 / !Zap / Docs / HelpData < prev    next >
Text File  |  1995-06-19  |  28KB  |  1,021 lines
  1. | Zap 'HelpData' file. This file contains:
  2. |
  3. | 1. Documentation on all Zap commands stored in the Zap and ZapBasic modules.
  4. | 2. Help text for Zap interactive help.
  5. |
  6. | The data in this file is used by the 'Help' command (^H) and the !Help
  7. | Application.
  8. |
  9. | The file format consists of paragraphs of the form:
  10. |
  11. | <label> [<comment>]
  12. | <paragraph of help text>
  13. |
  14. | where label is one of:
  15. |
  16. |   <command>        help text for command <command>
  17. |   window.<name>    help for leaf window with template called <name>
  18. |   mode_<name>        help for a window in mode called <name>
  19. |   zap.icon        help for Zap's main iconbar icon.
  20. |
  21. | Please keep the commands in alphabetical order to aid clarity.
  22. | NB Only the first 4 lines get displayed by the !Help application.
  23. |    Use ^H for more details.
  24.  
  25. | Main icon
  26.  
  27. zap.icon
  28. This is the Zap application.
  29. Zap is a text editor.
  30. Click SELECT to open a new text file.
  31. Drag a file onto this icon to load it.
  32.  
  33. | Window in mode 'n'
  34.  
  35. mode_text
  36. Text editing mode.
  37. Click SELECT to position the cursor.
  38. Click ADJUST to re-enable the cursor at its current position.
  39. Drag SELECT to set a selection or ADJUST to alter a selection.
  40. Double click to select a word.
  41. Treble click to select a line.
  42. Quadruple click to select a paragraph.
  43. Quintruple click to select the whole text.
  44.  
  45. mode_byte
  46. Byte editing mode.
  47. Toggle hex entry mode via sF3 and insert/overwrite mode via the Insert key.
  48. In hex entry mode keys 0-9,A-F,a-f enter hex bytes.
  49. While not in hex entry mode letters enter their Ascii values.
  50.  
  51. mode_word
  52. Word (32 bit) editing mode.
  53. Toggle hex entry mode via sF3 and insert/overwrite mode via the Insert key.
  54. In hex entry mode keys 0-9,A-F,a-f enter hex words.
  55. DELETE deletes a whole word.
  56. Use undo (F8 or Shift <-|) to remove the last digit typed.
  57.  
  58. mode_ascii
  59. ASCII editing mode.
  60. Type characters to insert them.
  61. Same as text mode except there is no return character.
  62.  
  63. mode_code
  64. Assembler instruction examining mode.
  65. Press RIGHT arrow to follow a branch and LEFT arrow to go back.
  66. Press RIGHT arrow or cI to indirect through the current address.
  67. Press RETURN to edit the current instruction.
  68. The instruction is assembled by BASIC so you can use any basic FNs.
  69. You can also use EQUD and EQUS but only the first 4 bytes will count.
  70.  
  71. mode_basic
  72. Tokenised BASIC editing mode.
  73. Press SHIFT-F8 to renumber the program.
  74. Press SHIFT-CTRL-F or SHIFT-CTRL-U to run the program.
  75.  
  76. mode_bastxt
  77. Detokenised BASIC editing mode.
  78. This is the same as the text mode except the program is tokenised on saving.
  79. Line numbers are inserted automatically in 1's.
  80. (So error at line 10 means the 10th line in the program).
  81.  
  82. mode_cmode
  83. Bryan Scattergood's C mode.
  84. Bracket matching can be configured from the mode menu.
  85. See Bryan's help text for more details.
  86.  
  87. mode_c
  88. Martin Ebourne's colour C mode.
  89. Colours can be configures from the display menu.
  90. Press scC to compile.
  91. See Martin's help text for more details.
  92.  
  93. mode_assembler
  94. Martin Ebourne's colour Assembler mode.
  95. Designed for Acorn's AAsm assembler files.
  96. See Martin's help text for more details.
  97.  
  98. mode_pascal
  99. Martin Ebourne's Pascal mode.
  100. See Martin's help text for more details.
  101.  
  102. mode_throwback
  103. This is a Zap throwback window.
  104. Double click SELECT or press RETURN on a line to go to the match.
  105. Treble click SELECT to jump to the match and bring the window to front.
  106. Click ADJUST or press DELETE on a line to remove the line.
  107. Double click SELECT with Shift held to jump & remove the throwback file.
  108.  
  109. mode_taskwindow
  110. Taskwindow output window.
  111. Most control letter keys and cursor keys are sent to the displayed task.
  112. Function keys and cursor-copying dealt with by Zap.
  113. Change to TEXT mode to suspend the task.
  114. Change back to TASKWINDOW mode to resume the task.
  115. Use ^C to copy the selected are to the input stream.
  116.  
  117. | Leaf windows
  118.  
  119. window.InfoBox
  120. This is the Zap info window.
  121. The application Zap is copyright Dominic Symes - see 'Copyright' file.
  122. Click on the 'Dominic Symes' for a list of mode authors.
  123. See the 'Copyright' file for my address.
  124.  
  125. window.GotoBox
  126. This window displays your current position in the text.
  127. Type the line number or address you wish to move to in the file.
  128. You may use expressions (eg '&100+32*78').
  129. Press CTRL U to clear the buffer.
  130.  
  131. window.SaveBox
  132. Drag the file type icon to a directory window to save the file.
  133. Press RETURN or click on 'OK' to save the file.
  134. Click ADJUST on 'OK' to save the file but leave the window open.
  135. Click MENU to bring up a file type menu.
  136.  
  137. window.DyingBox
  138. Click SAVE    (or press 'S') to save the file before it is discarded.
  139. Click DISCARD (or press 'D') to delete the file.
  140.  
  141. window.QuitBox
  142. Click QUIT (or press 'Q') if you wish to leave zap WITHOUT saving any files.
  143.  
  144. window.SaveSelBox
  145. Drag the file type icon to a directory window to save the selection.
  146.  
  147. window.SearchBox
  148. Type the search string and press RETURN to search for it.
  149. Click on 'Edit Macros' to change the search macros.
  150. Press TAB to recall the old search string.
  151. Press ctrl-letter keys to alter the options.
  152.  
  153. window.MacroBox
  154. The small boxes give the macro to match.
  155. The large boxes give the text to replace the macro with.
  156.  
  157. window.ReplaceBox
  158. Type search string then RETURN.
  159. Type replace string then RETURN.
  160. Press CTRL U to clear a buffer.
  161. Press ctrl-letter keys to alter the options.
  162.  
  163. window.NextBox
  164. Click REPLACE (or press R) to replace one match.
  165. Click TO END  (or press T or E) to replace all following matches.
  166. Click SKIP    (or press S) to move to the next match without replacement.
  167.  
  168. window.PrintBox
  169. Prints a file by use of the !Printers (printer driver) application.
  170. Printing uses the outline font selected via the display menu.
  171. Press PRINT to start printing.
  172.  
  173. window.DzapBox
  174. Type the filing system name (CASE SENSITIVE) and then press RETURN.
  175. The default drive number should then be filled in for you.
  176. Type the drive number then RETURN to change drive.
  177. Press READ SECTOR to read the disc.
  178.  
  179. window.QuickBox
  180. Click on PRINT or type RETURN to send the file to the printer.
  181. If this does not work for your printer then change the CR/LF DIP switch OR:
  182. Load the printer driver and save the file onto it.
  183.  
  184. window.MzapBox
  185. Drag the 'switcher' icon to a window/icon belonging to the task you want.
  186. Press RETURN or click on READ.
  187. Drag to a Zap taskwindow to read the taskwindow memory.
  188.  
  189. window.UndoBox
  190. If you turn off the UNDO remember that PASTE and YANK will no longer work.
  191.  
  192. window.LoadBox
  193. Click on 'EDIT' (or press E) to load the file into a separate buffer.
  194. Click on 'OVERWRITE' (or press O) to replace the current buffer.
  195.  
  196. window.SaveOBox
  197. Click on 'OVERWRITE' (or press O) to replace the file on disc.
  198.  
  199. window.SaveCBox
  200. Click on 'SAVE TO CSD' to save to the currently selected directory.
  201.  
  202. window.MiniBuf
  203. This is the Zap minibuffer.
  204. Drag with SELECT to move.
  205. Drag near the right hand edge to resize.
  206. Press ESCAPE to leave the minibuffer.
  207.  
  208. window.ColourBox
  209. This is the Zap 24 bit colour selector.
  210. Press one of the 16 wimp colours to set that colour.
  211. Drag the bars then click on 'Set' to set a general colour.
  212.  
  213. | ***************************************************************
  214. | *                       C O M M A N D S            *
  215. | ***************************************************************
  216.  
  217. ASSEMBLE <string>
  218. Assembles the instruction given by <string>.
  219. Places it at the current cursor position (using its file address).
  220. Assembly is performed by spawning a BASIC program.
  221.  
  222. AUTOINDENT
  223. Toggles auto indent on and off.
  224. (see b16 of w_flags)
  225.  
  226. BASEMAP <word>
  227. This command switches the key basemap to the given keymap number.
  228. All further keypresses will use this keymap.
  229. (It writes variables key_basemap and key_current - see E-Vars)
  230.  
  231. BASIC
  232. In Basic mode drops the user into BASIC with program loaded at PAGE.
  233. In a different mode will do something mode specific.
  234. (Calls mode entry point e_basic)
  235.  
  236. BEEP
  237. Makes a short beep.
  238. (Does a VDU 7)
  239.  
  240. BINDTOKEY <string>
  241. Evaluates string to a number and binds the currently learnt sequence
  242. to that key code. (eg BINDTOKEY "&1B").
  243. If <string> is not given then prompts you to press a key.
  244.  
  245. BITMAPLIST
  246. For internal use.
  247. Generates the menu of bitmap fonts.
  248.  
  249. CANCEL
  250. Cancel current Yank and Search-as-you-type operations.
  251. Cursor is restored to its original position.
  252.  
  253. CDOWN
  254. Moves cursor to the end of the file.
  255. A marker is left at you previous position.
  256. (Use sF6 to restore your position).
  257.  
  258. CHAR <byte>
  259. Inserts the character code <byte> into the file.
  260. Multiple presses are buffered (as with any byte call).
  261. (Uses mode entry point e_char)
  262.  
  263. CLEARSEL
  264. Clears any selected regions.
  265. (Calls Zap_ClearSel)
  266.  
  267. CLEFT
  268. Moves cursor to start of line.
  269. (uses mode entry point e_cminus)
  270.  
  271. CLI <string>
  272. Execute <string> as a command line interpreter command. Eg CLI "Set A 3".
  273. Output from the command is redirected to Null:.
  274. See also OSCLI and WIMPTASK.
  275.  
  276. CLOSEOTHER
  277. Closes the next window in the swap-window sequence.
  278. (Closes other window if only two are open)
  279.  
  280. CLOSEPRINTER
  281. Closes 'printer:$' filer window via *Filer_CloseDir.
  282.  
  283. CLOSEWINDOW
  284. Closes the current window.
  285. Puts the cursor in the next available window afterwards.
  286.  
  287. COLOURLIST
  288. Internally used command to create the colourlist menu.
  289.  
  290. COLUMNTAB
  291. Set tab mode to column tab.
  292. (Changes b9-10 of w_flags)
  293.  
  294. COMMAND <string>
  295. Executes the command (or colon separated list of commands) <string>.
  296. (Uses Zap_CommandString)
  297.  
  298. COMPILE
  299. In Basic mode saves the program to disc and then runs it.
  300. In C mode compiles the program.
  301. (Calls the mode entry point e_compile)
  302.  
  303. COPY
  304. Initiates split-cursor-copying mode.
  305. Each subsequent press copies a single character.
  306. (Switches cursor to mode 2 and uses mode entry point e_copy)
  307.  
  308. COPYSEL
  309. Copies the selected region to input caret position.
  310.  
  311. COREDUMP
  312. Produces an image of Zap's memory in Zap's directory.
  313. Use to produce a record of a nasty bug etc.
  314.  
  315. CREATEFILE <word>
  316. Creates an empty file of filetype <word>.
  317.  
  318. CRIGHT
  319. Moves to end of line using.
  320. (uses the mode entry point e_cminus)
  321.  
  322. CUP
  323. Moves to the start of a file, leaving a marker at the old offset.
  324.  
  325. CURSORMENU
  326. Internally used to produce the cursor types menu.
  327.  
  328. CUT
  329. Deletes the selected region.
  330. If the undo buffer is on, it can be pasted back with cY (Paste).
  331. If the undo buffer is off, then it's gone for ever!
  332.  
  333. DATE <string>
  334. Inserts a date string of format <string>.
  335. Eg, <string>=%MI to substitute the time in minutes.
  336. (uses OS_ConvertDateAndTime)
  337.  
  338. DEFAULTMAP
  339. Changes the key basemap to the default value.
  340. (default value specified in the 'keys' file)
  341.  
  342. DELETE
  343. Deletes the character before the cursor.
  344. (calls mode entry point e_delete with R7=0)
  345.  
  346. DELETENEXT
  347. Deletes the character under the cursor.
  348. (calls mode entry point e_delete with R7=1)
  349.  
  350. DELLINE
  351. Deletes the line the cursor is on.
  352. Cumulative deletes can be pasted in one go by cY.
  353. (uses e_lineprev and e_linenext to find the line limits)
  354.  
  355. DELTOEND
  356. Deletes from cursor to the end of the line.
  357. Deletes the line terminator if the cursor is at the line end.
  358. (uses e_lineend to find the line end)
  359.  
  360. DELTOSTART
  361. Deletes from cursor to the start of the line.
  362. (uses e_linestart to find the line start)
  363.  
  364. DOWN
  365. Moves cursor down a line.
  366.  
  367. DUMPFILE
  368. Creates a text image of the current display for this file.
  369.  
  370. DZAPBOX
  371. Opens the 'read disc' window.
  372.  
  373. EMACS
  374. Switches to Emacs key map emulation.
  375. (Sets Basemap to 1)
  376.  
  377. ESCAPE
  378. Cancels the following modes (leaving cursor where it is):
  379. copy-mode, yank-mode, select-via-cursor, search-as-you-type.
  380. See also Cancel (cG).
  381.  
  382. EXECUTE
  383. Execute last learnt sequence.
  384. (see cL)
  385.  
  386. FASTUNDO
  387. Undo the last operation taking the fastest route in the undo tree.
  388. For example if you do a,b,undo,c,fastundo,fastundo then it will
  389. delete the 'a' as opposed to inserting the 'b'.
  390.  
  391. FFLAGS_TOGGLE <word> 
  392. General purpose command to toggle one bit of the file flags word.
  393. The titlebar updated afterwards.
  394. See Wflags_Toggle for details of <word>.
  395.  
  396. FINDFILE <string>
  397. Opens a buffer on the indicated file (should be a full path name).
  398.  
  399. FINDFILEREADONLY <string>
  400. As for FINDFILE but puts in read only mode when file loaded.
  401.  
  402. FONTLIST
  403. Internally used to produce the menu of outline fonts.
  404.  
  405. FONTSIZE <word>
  406. Set the outline font size to <word>.
  407.  
  408. FONTTYPE <word>
  409. Sets the display font type according to word:
  410. 0=bitmap font at 1dpp, 1=scaled bitmap font, 2=system font via vdu.
  411. 3=anti-aliased font (quick) 4=anti-aliased font (via vdu)
  412. 5=bitmap font (double height).
  413.  
  414. FORMATTEXT
  415. Formats the current paragraph from the cursor position.
  416. Uses the wordwrap width for formatting.
  417.  
  418. FULLUNDO
  419. Undo the last operation taking the slowest route in the undo tree.
  420. For example if you do a,b,undo,c,fullundo,fullundo then it will insert
  421. the 'b' as opposed to deleting the 'a'. Compare this with Fast undo.
  422.  
  423. GETMODULE
  424. Internally used to open the list of modules to grab.
  425.  
  426. GETWORKSPACE
  427. Internally used to open the list of module workspace's to grab.
  428.  
  429. GETDYNAMICAREA
  430. Internally used to open the list of dynamic areas to grab.
  431.  
  432. GOTO
  433. Bring up the goto dialogue box.
  434.  
  435. HELP <string>
  436. Gives help on subject according to the first letter of <string>
  437. 'c' or 'f'=help on a command (Helpcom), 'k'=help on a key (via Helpkey)
  438. 'm'=help on the current mode, 'z'=Loads main help file on Zap.
  439.  
  440. HELPKEY <string>
  441. <string> is evaluated to a number and  help is given on that key code.
  442.  
  443. HELPCOM <string>
  444. Help is given on the command <string>.
  445.  
  446. HEXASCII
  447. Toggle hex/ascii entry mode.
  448. (uses b5 of the w_flags). Byte mode uses this for
  449.  
  450. ICONISE
  451. Iconises the window.
  452.  
  453. INDENT
  454. Indents the currently selected region by the string given in the
  455. menu option selection.indent. If this evaluates to a number then it
  456. indents by that number of spaces.
  457.  
  458. INDENTBY <string>
  459. Indents the selected area by <string>.
  460. If <string> is a number then uses that many spaces.
  461. If <string> is negative then outdents.
  462.  
  463. INDIRECT
  464. Jump to the address contained at the word at the current cursor position.
  465. (leaving a marker behind as with any jumps)
  466.  
  467. INFOBOX
  468. Opens the info box.
  469.  
  470. INSERT <string>
  471. Inserts <string> into the file.
  472. (Uses the mode entry point e_char)
  473.  
  474. INSERTDATE
  475. Insert the current date using the format in the keys file.
  476. (variable &300)
  477.  
  478. INSERTGS <string>
  479. Inserts <string> into the file, GS-Transing it first.
  480. Hence, you can include control code (eg |M).
  481. (Uses the mode entry point e_char)
  482.  
  483. INSERTTIME
  484. Insert the current time using the format in the keys file.
  485. (variable &301)
  486.  
  487. JOINLINE
  488. Joins the current line to the following line.
  489. (uses the mode entry point e_joinline)
  490.  
  491. KEEPREGION
  492. Copies the selected region to the yank buffer (Emacs kill ring).
  493. The region can be pasted again using cY.
  494. This is the equivalent of Emacs Meta-W.
  495.  
  496. KEYMAP <word>
  497. Change the keymap to <word> for the next key press only.
  498. After the next key press the keymap will revert to Basemap value.
  499. (Eg Used for ctrl-X extensions in the Emacs key map)
  500.  
  501. LASTMARK
  502. Jump to the previous mark in the market buffer.
  503.  
  504. LASTMATCH
  505. Move to the previous match of the current search string.
  506. Will move across files if the 'all files' option is set.
  507.  
  508. LASTSECTOR
  509. Move to the last sector on an (unaltered) file read from disc.
  510.  
  511. LASTTRACK
  512. Move to the last track on a file read from disc.
  513.  
  514. LEARN
  515. Start or stop learning a key sequence.
  516. Use Execute (F1) to replay the learnt sequence.
  517. NB Escape will be learnt and will not stop the learning.
  518.  
  519. LEFT
  520. Move cursor left.
  521. (calls mode entry point e_minus)
  522.  
  523. LINEEDIT
  524. Toggles line edit mode on and off.
  525. (uses b14 of w_flags)
  526.  
  527. LINENOS <word>
  528. Change line number state of the window to <word>.
  529. 0=no line numbers 1=logical line nos 2=physical line nos 3=addresses.
  530.  
  531. LINESPACING <word>
  532. Sets the line spacing to <word>.
  533.  
  534. LINEWRAP
  535. Toggles line wrap mode on and off.
  536. (b26 of w_flags)
  537.  
  538. LISTFNS
  539. Lists function definitions for the given mode.
  540. (via e_listfns)
  541.  
  542. LOADLIST
  543. Internally used to generate a menu of modes to load.
  544.  
  545. LOADMODULE <string>
  546. Load the module given by filename <string> as a Zap module.
  547. Warning: This is very low level - loading a module which is
  548. already loaded will cause a crash.
  549.  
  550. MAKEDEFAULT
  551. This saves the window's options as the current default options.
  552. Follow this by a 'save options' to make the current window dictate
  553. the default options. Useful for setting default colours.
  554.  
  555. MARGIN <word>
  556. Set the margin to <word>.
  557.  
  558. MINIMENU
  559. Internally used to create the minibuffer options menu.
  560.  
  561. MINIMISEMEMORY
  562. Contacts heap by as much as possible.
  563. I'm afraid it's an Acorn OS_Heap type heap so this won't usually do much.
  564. Automatically done whenever a file is removed from Zap.
  565.  
  566. MISCOPS <word>
  567. Toggles a miscellaneous option according to <word>
  568.  0=Auto removal of files when a window closes
  569.  1=Auto clearing of selection regions when a character typed
  570.  2=reserved
  571.  3=Flashing cursor
  572.  4=Check datestamp before saving a file
  573.  5=Auto clear of search box when opened
  574.  6=Confine cursor to visible area of the window
  575.  
  576. MODE <word>
  577. Change the current display mode to <word>.
  578. Use MODEN in preference.
  579.  
  580. MODEN <string>
  581. Change to the display mode named <string>.
  582.  
  583. MOVESEL
  584. Move the selected area to current cursor offset.
  585.  
  586. MULTICOMMAND <data>
  587. Executes a list of other commands (eg learnt sequence or ':' separated
  588. chain of commands). The list is stored in the data block.
  589. The data block is a -1 terminated list of entries of the form given below.
  590. Note that all the data for the commands to be executed is stored within the
  591. data block except for data type 4 (other multicommands).
  592.     #0 Command address
  593.     #4 Data length/number of times (R1 on command entry)
  594.     #8 Command data. Depends on the type of the command (see E-command):
  595.         0 No data
  596.         1 List of #4 bytes then align
  597.         2 List of #4 words
  598.         3 0 terminated string then align
  599.         4 Pointer to the data block 
  600.  
  601. MZAPBOX
  602. Opens the 'read memory' window.
  603.  
  604. NEWTYPE <word>
  605. Changes the file type of the file to <word>.
  606. Creates a file of value <word> if on main (options) menu.
  607.  
  608. NEWVIEW
  609. Open a new window on this file.
  610. (copying the old window mode and format)
  611.  
  612. NEWVIEWLIST
  613. Internally used to create the menu of files to open a new view on.
  614.  
  615. NEXTMARK
  616. Jump to next mark in the marker buffer.
  617.  
  618. NEXTMATCH
  619. Move to the next match of the current search string.
  620.  
  621. NEXTSECTOR
  622. Move to the next sector on a file read from disc.
  623.  
  624. NEXTTRACK
  625. Move to the next track on a file read from disc.
  626.  
  627. NONSTANDARD
  628. Toggles non standard editing on and off.
  629. (b15 of w_flags)
  630.  
  631. NULL
  632. Does nothing.
  633. (but prevents the key from being passed on via Wimp_ProcessKey)
  634.  
  635. OPENPRINTER
  636. Open a filer window on printer:$ via *Filer_OpenDir.
  637.  
  638. OSCLI <string>
  639. Execute <string> via the command line interpreter. Eg OSCLI "Help".
  640. Command output is sent indirected to <Wimp$Scrap>.
  641. The file is displayed if it's non null. See also CLI and WIMPTASK.
  642.  
  643. OUTDENT
  644. Outdents the selected region.
  645. (by the length of the current indent string)
  646.  
  647. PASTE
  648. Pastes the last cut region repeatedly.
  649. (Use YANK to cycle through previously deleted regions)
  650.  
  651. PRINTFILE
  652. Open the fancy print window.
  653.  
  654. QUICKPRINT
  655. Open the quick print window.
  656.  
  657. QUICKSAVE
  658. Save the file directly to disc with no prompt.
  659.  
  660. QUIT
  661. Kill Zap - dead!
  662. (prompts user to save altered files first)
  663.  
  664. QUOTE
  665. Causes the next key typed to have its key code entered into the text.
  666. It is the Zap key code that is entered.
  667. Hence you need to do cQ cSpace to get a 0.
  668.  
  669. READONLY
  670. Toggle the read only state of a file.
  671. (b8 of f_flags)
  672.  
  673. REDO
  674. Redo the last undone operation whether full or fast.
  675.  
  676. RELOADKEYS
  677. Reload the 'keys' file, reading the new key bindings.
  678.  
  679. REMOVELIST
  680. Internally used to produce the menu of files to remove.
  681.  
  682. RENUMBER
  683. In Basic mode this renumbers the program
  684. (In general calls the mode entry point e_renumber)
  685.  
  686. REPLACE
  687. Open the Search & Replace window.
  688.  
  689. RETURN
  690. Breaks the line (if not in line edit mode), indenting in auto-indent mode.
  691. Also cancels split cursor copying.
  692. (uses mode entry point e_return)
  693.  
  694. RETURNCHAR <word>
  695. Set the value of the file return character.
  696.  
  697. RETURNNOINDENT
  698. Breaks the line as for RETURN but does not indent in auto-indent mode.
  699.  
  700. RIGHT
  701. Move cursor right.
  702. (using mode entry point e_plus)
  703.  
  704. RUN
  705. In Basic mode this runs the basic program at PAGE.
  706. (in general calls the mode entry point e_run)
  707.  
  708. RUNANDQUIT
  709. In Basic mode this runs the basic program at PAGE and then quits BASIC.
  710. (in general calls the mode entry point e_runandquit)
  711.  
  712. SAVE
  713. Opens the save box.
  714.  
  715. SAVEANDRUN
  716. In Basic mode this saves the program to disc and the chains it.
  717. (in general calls the mode entry point e_saveandrun)
  718.  
  719. SAVEFILE <string>
  720. Save the current buffer with filename <string>.
  721. If <string> is omitted the buffer is saved under its current name.
  722. (unless it doesn't have a proper name when you are prompted for one)
  723.  
  724. SAVEOPTIONS
  725. Saves the current default options to the !Config file.
  726.  
  727. SAVESEL
  728. Opens the save selection box.
  729.  
  730. SCDOWN
  731. Move down display one line (without moving cursor).
  732.  
  733. SCLEFT
  734. Move to left of display one character (without moving cursor).
  735.  
  736. SCRIGHT
  737. Move to right of display one character (without moving cursor).
  738.  
  739. SCUP
  740. Move up display one line (without moving cursor).
  741.  
  742. SDOWN
  743. Move down a page.
  744.  
  745. SEARCHBACK <string>
  746. Search as you type backwards (if no arguments).
  747. Searches backwards for <string> if argument given.
  748. Cursor is placed at the end of the match.
  749.  
  750. SEARCHBUF <string>
  751. Open Search window with output to window option set (if no arguments).
  752. Produce a buffer containing all matches of <string> if argument given.
  753.  
  754. SEARCHCUR <string>
  755. Open Search window with output to cursor option set (if no arguments).
  756. Move cursor to the first match of <string> if argument given.
  757.  
  758. SEARCHFORWARD <string>
  759. Search as you type forwards (if no arguments).
  760. Searches forwards for <string> if argument given.
  761. Cursor is placed at the end of the match.
  762.  
  763. SELECTBUFFER
  764. Select entire buffer.
  765.  
  766. SELREGION
  767. Start selection of region by cursor movement.
  768. Use Escape to end the selection.
  769. (this sets the cursor mode to 4)
  770.  
  771. SETWIDTH <string>
  772. Set width of window to number contained in <string>.
  773. (calls mode entry point e_setwidth)
  774.  
  775. SLEFT
  776. Move cursor back a word.
  777. (calls e_sminus)
  778.  
  779. SPLITLINE
  780. Split line at current cursor position.
  781. (calls mode entry point e_splitline)
  782.  
  783. SRIGHT
  784. Move cursor forward a word.
  785. (calls e_splus)
  786.  
  787. STARTADDR <word>
  788. Set apparent start address of file to <word>.
  789. (this address is used in the margin in byte/code mode)
  790.  
  791. STARTLINE <word>
  792. Set the apparent line number of the first line in the file.
  793.  
  794. STRIPSPACES <word>
  795. Perform space altering commands according to the bits set in <word>.
  796. b0=Strip spaces at the end of lines, b1=Strip tabs at the end of lines
  797. b2=Tabify (ie convert spaces to tabs), b3+ reserved
  798.  
  799. SUP
  800. Move up a page.
  801.  
  802. SUSPEND
  803. Brings up the command line (same as F12).
  804.  
  805. SWAPCASE
  806. Swap case of next character/selected region if there is one.
  807.  
  808. SWAPCHARS
  809. Swap characters either side of cursor.
  810.  
  811. SWAPWINDOW
  812. Moves cursor to the next window in sequence.
  813. If several views are on the file then swaps between views.
  814.  
  815. SWITCHTAB
  816. This toggles the TAB mode for a file between UNIX and Truetab modes.
  817. (b9-b10 of w_flags)
  818.  
  819. TAB
  820. Performs the mode's tab action.
  821. (calls e_tab)
  822.  
  823. TABCHAR <word>
  824. Sets the current tab character (usually 9)
  825.  
  826. TABDISPLAY <word>
  827. Sets the way tabs are displayed according to <word>:
  828. 0=none 1=as spaces 2=arrow 3=dashes then arrow.
  829.  
  830. TABMODE <word>
  831. Sets the current tab insertion mode according to <word>:
  832. 0=unix tab 1=edit tab 2=column tab.
  833.  
  834. TABSASSPACES
  835. Toggles whether tabs are inserted as spaces or truetabs (char 9).
  836. (toggles b11 of w_flags)
  837.  
  838. TASKWINDOW
  839. Opens a new task window (creating a new task).
  840.  
  841. TOBACK
  842. Moves the window to the back of the window stack.
  843. (via Zap_OpenWindow 4)
  844.  
  845. TOFRONT
  846. Moves the window to the front of the window stack.
  847. (via Zap_OpenWindow 3)
  848.  
  849. TOGGLEHEX
  850. Toggle hex/decimal display of line numbers.
  851. (b10 of w_format)
  852.  
  853. TOGGLEINSERT
  854. Toggle insert/overwrite modes
  855. (b1 w_flags)
  856.  
  857. TOGGLEMARK
  858. Insert/delete mark from marker buffer at current cursor offset.
  859.  
  860. TOGGLEUNDO
  861. Toggle the undo buffer for a file on and off.
  862.  
  863. TOGGLEWIND
  864. Toggles the window size.
  865. (he not-fully-open size is stored in w_togminx to w_togmaxy)
  866.  
  867. UNIVERSALARG <string>
  868. Evaluates <string> to a number and then passes it to the next command.
  869. This usually has the effect of executing the next command <string> times.
  870.  
  871. UNSPACE
  872. Remove excess spacing around the cursor.
  873.  
  874. UP
  875. Move cursor up a line.
  876.  
  877. WFLAGS_ALTER <word>
  878. Command to alter bits of the w_flags or opt_flags word.
  879. The window is redrawn afterwards to display the new status.
  880. The <word> is as for Wflags_toggle.
  881.  
  882. WFLAGS_TOGGLE <word>
  883. Command to alter bits of the w_flags or opt_flags word.
  884. The titlebar is updated after the toggle.
  885. The <word> is a short 'program' consisting of up to 4 instructions in
  886. the 4 bytes. Each byte has the form:
  887.  b0-b4 = bit to effect
  888.  b5-b6 = 0=> toggle the bit, 1=> set the bit, 2=> clear the bit
  889.  b7    = 1 to show this byte is active (in the top 3 bytes only)
  890. Eg, &5 means 'toggle bit 5'
  891. Eg, &8609 means toggle bit 9 then toggle bit 6 etc.
  892.  
  893. WFORMAT_ALTER <word>
  894. Command to alter bits of the w_format or opt_format words.
  895. The titlebar is updated afterwards but the window not redraw.
  896. The <word> is as for Wflags_toggle.
  897.  
  898. WFORMAT_TOGGLE <word>
  899. Command to alter bits of the w_format or opt_format words.
  900. The window is redrawn afterwards to display the new status.
  901. The <word> is as for Wflags_toggle.
  902.  
  903. WIMPTASK <string>
  904. Execute <string> as an OSCLI command via Wimp_StartTask.
  905. Differs from OSCLI and CLI in that VDU output is not redirected.
  906. Should be used for starting up other applications.
  907.  
  908. WORDWRAP
  909. Toggle wordwrap mode on/off.
  910. (toggles b13 w_flags)
  911.  
  912. WRAPWIDTH <word>
  913. Set the wordwrap width.
  914.  
  915. WRITEFILE <string>
  916. Saves the buffer with filename <string>.
  917. If <string> is not given then it prompts for a filename.
  918. (it differs from Savefile which doesn't usually prompt)
  919.  
  920. YANK
  921. Paste last cut region from undo buffer to current cursor position.
  922. On repeated action it pastes previously cut regions in a cyclic manor.
  923.  
  924. | ***************************************************************
  925. | *                      ZapMJE extensions            *
  926. | ***************************************************************
  927.  
  928. | Modes
  929.  
  930. mode_c
  931. Martin Ebourne's colour C mode.
  932. Colours can be configured from the display menu.
  933. Press scC to compile.
  934. See Martin's help text for more details.
  935.  
  936. mode_c++
  937. Martin Ebourne's colour C++ mode.
  938. Colours can be configured from the display menu.
  939. Press scC to compile.
  940. See Martin's help text for more details.
  941.  
  942. mode_assembler
  943. Martin Ebourne's colour Assembler mode.
  944. Designed for Acorn's ObjAsm assembler files.
  945. Press scC to compile.
  946. See Martin's help text for more details.
  947.  
  948. mode_pascal
  949. Martin Ebourne's Pascal mode.
  950. Press scC to compile.
  951. See Martin's help text for more details.
  952.  
  953. | Commands
  954.  
  955. MJE_ALTERSEL
  956. Move the closest end of the selection to the current cursor position (like
  957. Adjust). If there is no selection then select the next character.
  958.  
  959. MJE_CLOSECOMMENT
  960. Insert close comment string.
  961. (ZapMJE modes only)
  962.  
  963. MJE_COMMENT
  964. Insert open and close comment strings leaving the cursor in the middle.
  965. (ZapMJE modes only)
  966.  
  967. MJE_COMMENTLINE
  968. Comment out the entire line and move onto next.
  969. (ZapMJE modes only)
  970.  
  971. MJE_ENDIF
  972. Insert end pre-processor 'comment'; ie. use conditional compilation to
  973. disable a code section.
  974. (ZapMJE modes only)
  975.  
  976. MJE_GENERATEHEADER
  977. Automatically append function declarations onto the end of the corresponding
  978. header file.
  979. (C mode only)
  980.  
  981. MJE_HELPCONTEXT
  982. Find help for the word at the cursor, using Guttorm Vik's StrongHelp.
  983. Note that StrongHelp is not supplied with Zap.
  984.  
  985. MJE_HELPTOPIC <string>
  986. Find help for the supplied string, using Guttorm Vik's StrongHelp.
  987. If there is no supplied string then find help for the selected word, else
  988. prompt for the word in the minibuffer.
  989. Note that StrongHelp is not supplied with Zap.
  990.  
  991. MJE_IF
  992. Insert start pre-processor 'comment'; ie. use conditional compilation to
  993. disable a code section.
  994. (ZapMJE modes only)
  995.  
  996. MJE_IFMODE <string>
  997. Execute given command string only if the current mode is in the supplied
  998. list. See Martin Ebourne's help text for further details.
  999.  
  1000. MJE_LASTFUNC
  1001. Jump to the start of the previous function definition.
  1002. (ZapMJE modes only)
  1003.  
  1004. MJE_NEXTFUNC
  1005. Jump to the start of the next function definition.
  1006. (ZapMJE modes only)
  1007.  
  1008. MJE_OPENCOMMENT
  1009. Insert open comment string.
  1010. (ZapMJE modes only)
  1011.  
  1012. MJE_SWAPTOHEADER
  1013. Move cursor into corresponding header or source file, possibly loading it.
  1014. (ZapMJE modes only)
  1015.  
  1016. MJE_UNCOMMENTLINE
  1017. Uncomment line and move onto next.
  1018. (ZapMJE modes only)
  1019.  
  1020. | End
  1021.